You are here: BlueCielo Meridian Enterprise Administrator's Guide > Installing Meridian > Installing the webhelp documentation

Installing the webhelp documentation

The documentation for BlueCielo products is available in several formats:

The Microsoft HTML Help files are installed and shown by default by the Meridian client applications. The webhelp files are available from BlueCielo by request.

The online webhelp files are shown when a user presses the F1 key within Meridian applications and the user has enabled the I prefer online help option in the User assistance experience group on the General tab in the Options dialog box of PowerUser. If the I prefer local help option is enabled, this value is ignored and the locally installed content (*.chm) files are shown instead. These options also affect the other Meridian client applications, for example, the web client, Meridian Enterprise Administrator and Meridian Enterprise Configurator.

The help documentation is hosted by BlueCielo at the URL http://documentation.bluecieloecm.com/. The documentation can also be hosted on your web server to place it inside of your organization's firewall if Internet access is not permitted, for example. In that case, you are responsible for installing and maintaining the documentation.

To install the webhelp documentation:

  1. Create a folder structure on the web server where you want the files to reside. The folder structure should contain subfolders for the documentation for each language, product, version, and manual that will be installed. The folder structure should use the hierarchy: <Language>/<Product>/<MajorVersion>/<Document>. Valid names for these subfolders are listed in the following tables.
  2. Copy the webhelp files (including any subfolders) to the web server in the appropriate <Document> subfolders.
  3. If you did not create the folder structure within the default web site, create a virtual folder in the default web site that refers to the webhelp parent folder.
  4. Set the WebHelpBaseURL registry value on each client computer that you want to show the installed documentation. For more information about the value, see HKEY_CURRENT_USER\Software\Cyco\AutoManager Meridian\CurrentVersion.
  5. NEW  Set the WebHelpVersion registry value on each client computer that you want to show the installed documentation. For more information about the value, see HKEY_LOCAL_MACHINE\Software\Cyco\AutoManager Meridian\CurrentVersion
  6. Instruct users to enable the I prefer online help option as described previously. Alternatively, set the UseWebHelp registry value on each client PC as described in HKEY_CURRENT_USER\Software\Cyco\AutoManager Meridian\CurrentVersion\Client\Settings.

Valid subfolder names for <Language> include: en

Valid subfolder names for <Product> include the following: 

<Product> subfolder names
Name Description

apwfm

Meridian Advanced Project Workflow Module

amm

Meridian Asset Management Module

em

Meridian Email Manager

explorer

Meridian Explorer

fda

Meridian FDA Module

gcf

Meridian Global Collaboration Framework

gcfsp

Meridian Global Collaboration Framework/SharePoint

meridian

Meridian Enterprise

publisher

BlueCielo Publisher

tmm

Meridian Transmittal Management Module

wp

BlueCielo Web Parts

Valid subfolder names for <MajorVersion> include the major version numbers (for example, 2015 or 2015 SP1) of Meridian Enterprise and its modules beginning with version 2012.

Valid subfolder names for <Document> include the following: 

<Document> subfolder names
Name Description

ag

Administrator's Guide

cg

Configuration Guide

ug

User's Guide

dg

Developer's Guide

vr

VBScript API Reference

ss

Supported Software

Note    Not all documents are available for all products.

For example, if the Meridian Enterprise Administrator's Guide webhelp files are installed at //MeridianServer/BCWebHelp/en/meridian/2015/ag, the value of WebHelpBaseURL should be set to http://MeridianServer/BCWebHelp/. The trailing slash character is required.

Related concepts

About Meridian deployment strategies

Installing Meridian

What to expect after Meridian installation

About AutoVue

Related tasks

Preparing for installation

Starting Meridian installation

Installing the server components

Finishing up installation

Installing Web Access on a different server

Installing supplemental documentation

Uninstalling Meridian

Installing AutoVue


www.bluecieloecm.com